API & WebHooks
This webhook method is for one application or system to communicate with another in real-time.
Follow the below steps
1 Go to Dashboard > Audit > Streamers.
2 Click on API & WebHooks.
3 The "How to" tab will appear, providing a step-by-step guide for the configuration setup.
4 Click on Configuration.
5 Toggle the enable button for Enabled API & WebHooks. This action will reveal a set of configuration.
Configuration
(*) Indicates that the action is mandatory.
| Configuration | Description |
|---|---|
| ID | Provide the ID. |
| *Webhook Url | Set the URL to which events will be delivered. (NOTE: Only POST method is supported.) You can obtain this URL from WebHook. |
| Authorization | Set an authorization token or provide a base64-encoded token to be included in the header as the Authorization. |
| Send Admin Events | Enable this option to transmit admin events. |
| Events Types | Choose the event types that should be forwarded to the WebHook. If none are selected, no events will be pushed. |
note
- The payload will be delivered in JSON format. Please keep this in mind while consuming the logs in your WebHook.
- The streamer will be automatically disabled if the WebHook servers are unreachable or experiencing issues.
6 After providing the necessary configurations. Click on SAVE.
7 Then, click on TEST CONFIGURATION to verify that the configuration is correct. If the test is successful, you will see LIVE displayed next to API & WebHooks.